/projects/{projectId}/points (Get)

Gets an array of point objects that satisfy the query criteria

Name	Description	Data Type
projectId	the id of the project	string
HasAlarm	filters the list of points based on the presence of alarm configuration	boolean
PointID	provides a wild card string to filter points by their PointID.	string
DeviceID	Device ID for the point, where the point data originates. If the point is a global point, the device is "$GLOBAL". If the point is an equation point, the device is $DERIVED.	string
ResourceID	provides a wild card string to filter points by their ResourceID.	string
PointTypeID	Point Type ID of the point (UINT, REAL, etc.)	string
Description	provides a wild card string to filter points by their Description.	string
AccessFilter	If the point is an enterprise point, this field is set to E.	string
MaxItems	Maximum number of points to return	number

The response body is of type PointsGetResponse.

The collection of points that satisfy the query.

Overview

PointsGetResponse

The results of the points get query.

Points : Array[CimPoint]

AttributeSet : string

DataLen : integer

DataType : CimPointTypesEnum

DeadBand : string

DerivedPoint : CimDerivedPoint

CalculationType : CimPointCalcTypesEnum

InitState : CimDpInitStateEnum

InitValue : string

Local : boolean

PointExpression : string

PointSetInterval : string

PointSetTime : string

ProcessID : string

ResetPointID : string

RolloverVal : integer

VarianceValue : integer

Description : string

DevicePoint : CimDevicePoint

Address : string

AddressOffset : integer

AddressType : CimMMSAddressTypeEnum

AnalogDeadband : string

DelayLoad : boolean

DeviceID : string

JustInTime : boolean

PollAfterSetpoint : boolean

ScanRate : integer

TriggerType : CimDeviceTriggerEnum

TriggerValue : string

UpdateCriteria : CimUpdateCriteriaEnum

DisplayFormat : string

DisplayLimitHigh : string

DisplayLimitLow : string

Elements : integer

EngineeringUnits : CimEngineeringUnits

EuExpression : string

EuLabel : string

EuRevExp : string

HighConvValue : string

HighRawValue : string

LinearConversion : boolean

LowConvValue : string

LowRawValue : string

EnterprisePoint : boolean

EnumFields : Array[CimPointEnumField]

Text : string

Value : integer

SetpointAllowed : boolean

EnumerationID : string

EuExists : boolean

Expressions : Array[CimClassDataItemExpression]

FirstOperandNum : number

FirstOperandString : string

ID : string

Operator : CimExpressionOperandTypesEnum

SecondOperandNum : number

SecondOperandString : string

Extra : integer

InvertAvailabilityTrigger : boolean

Level : integer

LogData : boolean

LogDataHistorian : boolean

MeasurementUnitID : string

MeasurementUnit : CimMeasurementUnit

UnitId : string

Description : string

FullName : string

DisplayLabel : string

NamespaceUri : string

NumericUnitId : integer

OPCUA_NodeID : string

PointAlarm : CimPointAlarm

Alarm : CimAlarm

AckTimeout : integer

AlarmClass : string

AlarmDescription : string

AlarmID : string

AlarmMessage : string

AlarmTypeID : string

Changeapproval : CimChangeapprovalEnum

DeleteOpt : CimAlarmDelOptEnum

HelpFileName : string

HiAckTimeout : integer

HiDeleteOpt : CimAlarmDelOptEnum

HiHiAckTimeout : integer

HiHiDeleteOpt : CimAlarmDelOptEnum

HiHiLogOpt : string

HiHiRepeatTimeout : integer

HiHiResetAllowed : boolean

HiHiResetTimeout : integer

HiLogOpt : string

HiRepeatTimeout : integer

HiResetAllowed : boolean

HiResetTimeout : integer

LoAckTimeout : integer

LoDeleteOpt : CimAlarmDelOptEnum

LoLoAckTimeout : integer

LoLoDeleteOpt : CimAlarmDelOptEnum

LoLoLogOpt : string

LoLoRepeatTimeout : integer

LoLoResetAllowed : boolean

LoLoResetTimeout : integer

LoLogOpt : string

LoRepeatTimeout : integer

LoResetAllowed : boolean

LoResetTimeout : integer

LogOpt : string

MaxStacked : integer

Published : boolean

RepeatTimeout : integer

ResetAllowed : boolean

ResetTimeout : integer

Routing : Array[string]

Severity : integer

AlarmConfigured : boolean

AlarmCriteria : CimPointAlarmEnum

AlarmDelay : boolean

AlarmHigh : string

AlarmLow : string

AlarmMessage : string

AlarmOffDelay : boolean

AlarmStrID : integer

AlarmValueUpdate : boolean

DeviationPtID : string

HiDelayInterval : string

HiDelayUnit : CimTimeUnitEnum

HiHiDelayInterval : string

HiHiDelayUnit : CimTimeUnitEnum

HiHiOffDelayInterval : string

HiHiOffDelayUnit : CimTimeUnitEnum

HiOffDelayInterval : string

HiOffDelayUnit : CimTimeUnitEnum

LoDelayInterval : string

LoDelayUnit : CimTimeUnitEnum

LoLoDelayInterval : string

LoLoDelayUnit : CimTimeUnitEnum

LoLoOffDelayInterval : string

LoLoOffDelayUnit : CimTimeUnitEnum

LoOffDelayInterval : string

LoOffDelayUnit : CimTimeUnitEnum

TimeInterval : string

TimeUnit : CimTimeUnitEnum

WarningHigh : string

WarningLow : string

PointID : string

PointState : boolean

PointTypeID : string

Published : boolean

RangeLimitHigh : string

RangeLimitLow : string

ReadOnly : boolean

ResourceID : string

SafetyPointID : string

ScreenID : string

SetpointLimitHigh : string

SetpointLimitLow : string

TrendBuffering : CimTrendPtBuffer

Duration : integer

MaxBuffered : integer

TriggerCheckPointID : string

TriggerPointID : string

Type : CimPointOriginEnum

changeapproval : CimChangeapprovalEnum

OpcUaDeviceContexts : Array[CimOpcUaDeviceContext]

DeviceId : string

NamespaceUris : Array[string]

ServerUris : Array[string]

Fault	Description
404	This fault returns a response body of type ProblemDetails. Error if objects not found
400	This fault returns a response body of type . General error

All Operations Resource Group | CIMPLICITY Configuration REST API Web Service